Skip to content

docs: add single-host monitoring guide for Arc EL + CL#47

Open
Bela1401 wants to merge 5 commits intocirclefin:mainfrom
Bela1401:docs/single-host-monitoring-v2
Open

docs: add single-host monitoring guide for Arc EL + CL#47
Bela1401 wants to merge 5 commits intocirclefin:mainfrom
Bela1401:docs/single-host-monitoring-v2

Conversation

@Bela1401
Copy link
Copy Markdown

Summary

This PR adds a practical monitoring guide for operators running a single Arc
execution layer + consensus layer on one Ubuntu host.

It documents:

  • Prometheus scrape targets for EL and CL metrics
  • a minimal Grafana + Prometheus setup
  • dashboard provisioning
  • local access via SSH tunneling
  • common troubleshooting notes observed during real-world setup

Scope

This PR intentionally stays focused on a single-host operator setup and does not
attempt to cover multi-node or production observability architectures.

Related docs change

This PR also adds a reference from docs/running-an-arc-node.md to the new
docs/monitoring.md guide.

Notes

This PR supersedes the earlier closed PR #28, which was auto-closed after the
target branch changed.

Add Prometheus and Grafana setup instructions for a single Arc EL + CL node on one host.
Add a reference to docs/monitoring.md from running-an-arc-node.md.
@Bela1401
Copy link
Copy Markdown
Author

Reopened this as a fresh PR on top of the updated main, as suggested in the previous discussion.

This supersedes #28.

@Bela1401
Copy link
Copy Markdown
Author

1 2 3 4 5 Validation screenshots from the earlier single-host setup are attached below for context.

Copy link
Copy Markdown

@sdaveas-circle sdaveas-circle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested the guide's configs against a running EL+CL network (Quake testnet with 5 validators). The technical content is solid:

  • Prometheus scrapes both EL (/) and CL (/metrics) successfully
  • Grafana auto-provisions 8 dashboards from the repo's existing JSONs
  • Datasource UID prometheus resolves correctly
  • Real metrics data flows end-to-end (verified reth_info, arc_malachite_app_block_time_count, both targets up)

The configs, ports, paths, and network_mode: host approach all work correctly. One critical formatting issue blocks merging — see inline comment.

Comment thread docs/monitoring.md Outdated
Bela1401 and others added 2 commits April 27, 2026 15:10
Add missing code fences (```sh/```yaml) around all shell commands
and config blocks. Promote plain-text section titles to proper
## and ### headings. Format inline paths, URLs, and lists as
markdown. No content changes.
@sdaveas-circle
Copy link
Copy Markdown

sdaveas-circle commented Apr 27, 2026

@Bela1401 I opened a PR to suggest some clearer formatting for sections and code blocks. Please take a look when you have the chance!

Bela1401#1

docs: fix markdown fences and heading structure
@Bela1401
Copy link
Copy Markdown
Author

Merged the suggested formatting updates from the follow-up PR in my fork. Thanks.

@ZhiyuCircle ZhiyuCircle added pending-import PR awaiting import to crcl-main/circle-chain-reth and removed imported labels Apr 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-import PR awaiting import to crcl-main/circle-chain-reth

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants